home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / a_man / cat1 / makewhatis.z / makewhatis
Encoding:
Text File  |  1998-10-20  |  3.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4. mmmmaaaakkkkeeeewwwwhhhhaaaattttiiiissss((((1111MMMM))))                                                  mmmmaaaakkkkeeeewwwwhhhhaaaattttiiiissss((((1111MMMM))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      makewhatis, manwhat - make manual page "whatis" database for use with
  10.      apropos
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ////uuuussssrrrr////lllliiiibbbb////mmmmaaaakkkkeeeewwwwhhhhaaaattttiiiissss [----MMMM manpath] [filename]
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      _m_a_k_e_w_h_a_t_i_s scans the manual page (also known as reference page) trees,
  17.      parses the manual pages, and strips out the NAME section information to
  18.      create the "whatis" database used by _a_p_r_o_p_o_s(1), _m_a_n(1), and _w_h_a_t_i_s(1).
  19.  
  20.      By default, _m_a_k_e_w_h_a_t_i_s creates the file /_u_s_r/_s_h_a_r_e/_c_a_t_m_a_n/_w_h_a_t_i_s.
  21.      Another file can be created as the database by specifying its filename on
  22.      the command line.
  23.  
  24.      An alternate manual page tree can be specified by using the ----MMMM option to
  25.      specify a path or paths to a manual page tree or trees.  See the
  26.      discussion of the ----MMMM option in _m_a_n(1) for more details.
  27.  
  28.      The format of the "whatis" file is based on that used by William Joy's UC
  29.      Berkeley version of _a_p_r_o_p_o_s.
  30.  
  31. EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
  32.      The environment variables used by _m_a_n(1) apply to _m_a_k_e_w_h_a_t_i_s.
  33.  
  34. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  35.      awf(1), apropos(1), man(1), sgindexAdmin(1), whatis(1).
  36.  
  37. FFFFIIIILLLLEEEESSSS
  38.      /usr/share/catman          manual page tree
  39.      /usr/share/catman/whatis   "whatis" database
  40.      /usr/lib/manwhat The specialized version of the man(1) program that is
  41.      used to build the database.
  42.  
  43. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  44.      Expect execution times of about 10-30 minutes, depending on the number of
  45.      manual pages installed.  The reason is that the first portion of EVERY
  46.      manual page on the system is read.
  47.  
  48.      If unformatted (_n_r_o_f_f source) man pages are present, the _d_w_b product
  49.      should be installed, or _m_a_k_e_w_h_a_t_i_s may issues warning messages, because
  50.      it falls back on an awk script called _a_w_f(_1) that emulates nroff -man.
  51.  
  52.      You must run _m_a_k_e_w_h_a_t_i_s as root.
  53.  
  54. NNNNOOOOTTTTEEEE
  55.      This program is run automatically in the background during system bootup,
  56.      whenever products have been installed or removed (when /_v_a_r/_i_n_s_t/_h_i_s_t is
  57.      newer than /_u_s_r/_s), from the script /_e_t_c/_i_n_i_t._d._c_o_n_f_i_g_m_s_g.  As of the
  58.      IRIX 6.5 release, the _s_g_i_n_d_e_x_A_d_m_i_n(1) program will run first, and use the
  59.      installed information where possible, to reduce runtime.  Only if that
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. mmmmaaaakkkkeeeewwwwhhhhaaaattttiiiissss((((1111MMMM))))                                                  mmmmaaaakkkkeeeewwwwhhhhaaaattttiiiissss((((1111MMMM))))
  71.  
  72.  
  73.  
  74.      program is not found, or fails, will _m_a_k_e_w_h_a_t_i_s run to build the
  75.      database.
  76.  
  77.      Manual pages in source form that use the ....ssssoooo directive will cause
  78.      makewhatis to complain that the other file can't be found, unless it is a
  79.      full pathname.
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.